//=============================================================================
// System  : MatchKit
// File    : MatchKitException.cs
// Author  : Fabio Bussu  (matchkit@fabiobussu.it)
// Updated : 04/16/2013
// Note    : Copyright 2013, Fabio Bussu, All rights reserved
//
// This code is published under the Microsoft Public License (Ms-PL). A copy
// of the license should be distributed with the code.  It can also be found
// at the project website: http://matchkit.codeplex.com. This notice, the
// author's name, and all copyright notices must remain intact in all
// applications, documentation, and source files.
//
// Version     Date     Who  Comments
// ============================================================================
// 1.0.0.0  04/16/2013   FB  First draft
//=============================================================================
using System;
using System.Runtime.Serialization;

namespace MatchKit
{
	/// <summary>
	/// The exception that is thrown when the matching process runs into a critical error. All specific 
	/// exceptions throwned by MatchKit library inherits from this class.
	/// </summary>
	/// <conceptualLink target="0a06b2a9-5f58-409a-ba62-639cfd77bca7" />
	public class MatchKitException : Exception
	{
		/// <summary>
		/// Gets a value specifing the identification error code.
		/// </summary>
		public int ErrorCode { get; private set; }

		/// <summary>
		/// Initializes a new instance of the <see cref="T:MatchKit.MatchKitException"/> class.
		/// </summary>
		/// <param name="code">The identification error code.</param>
		public MatchKitException(int code)
		{
			ErrorCode = code;
		}

		/// <summary>
		/// Initializes a new instance of the <see cref="T:MatchKit.MatchKitException"/> class.
		/// </summary>
		/// <param name="code">The identification error code.</param>
		/// <param name="message">The error message.</param>
		public MatchKitException(int code, string message)
			: base(message)
		{
			ErrorCode = code;
		}

		/// <summary>
		/// Initializes a new instance of the <see cref="T:MatchKit.MatchKitException"/> class.
		/// </summary>
		/// <param name="code">The identification error code.</param>
		/// <param name="message">The error message.</param>
		/// <param name="args">Objects to format in the error message.</param>
		public MatchKitException(int code, string message, params object[] args)
			: base(string.Format(message, args))
		{
			ErrorCode = code;
		}

		/// <summary>
		/// Initializes a new instance of the <see cref="T:MatchKit.MatchKitException"/> class.
		/// </summary>
		/// <param name="code">The identification error code.</param>
		/// <param name="message">The error message.</param>
		/// <param name="inner">The exception that is the cause of the current exception.</param>
		public MatchKitException(int code, string message, Exception inner)
			: base(message, inner)
		{
			ErrorCode = code;
		}
	}
}
